WriteComments(string,int,IEnumerable<RasterCommentMetadata>) Method

Summary

Writes one or more comments to an existing file.

Syntax

Objective-C

C++

public void WriteComments( 
   string fileName, 
   int pageNumber, 
   IEnumerable<RasterCommentMetadata> comments 
)

Public Overloads Sub WriteComments( _ 
   ByVal fileName As String, _ 
   ByVal pageNumber As Integer, _ 
   ByVal comments As IEnumerable(Of RasterCommentMetadata) _ 
)

- (BOOL)writeComments:(nullable NSArray<LTRasterCommentMetadata *> *)comments  
               toFile:(NSString *)file  
           pageNumber:(NSInteger)pageNumber  
                error:(NSError **)error

public: 
void WriteComments(  
   String^ fileName, 
   int pageNumber, 
   IEnumerable<RasterCommentMetadata^>^ comments 
)

Parameters

fileName
A String that contains the file name.

pageNumber
1-based index of the page at which to write the comment.

comments
A collection of RasterCommentMetadata objects containing the comments data.

Remarks

This function only applies to TIF, EXIF, JPEG, JPEG 2000 or FPX files.

When you add or remove tags, the tags array at the end of the file is re-written. When you modify existing tags, the new tag value is added to the file and the IFD is modified as necessary. In all of these cases, there is no image recompression.

Some restrictions apply to this function if you use an IFD to indicate to which page to write the comment. See the Loading and Saving Large TIFF / BigTIFF Files topic for more information.

Example

For an example, refer to ReadComment.

Requirements

Target Platforms